package cz.semjobKB.virtuoso.document.api;

/**
 * Interface contains methods to retrieve details about terminology collected from a database
 */
public interface ITerminologyDetail extends IResourceDetail{
	
	/**
	 * Gets the terminology frequency for a given document
	 * @return Frequency of the terminology in document
	 */
	public Integer getFrequency();
	
	/**
	 * Gets the overall frequency over all documents
	 * @return Overall frequency of the terminology
	 */
	public Integer getOverallFrequency();
	
	/**
	 * Gets number of documents having the terminology
	 * @return	Number of documents having the terminology
	 */
	public Integer getTotalCount();
	
	/**
	 * Sets the tf-idf value for the terminology
	 * @param tfidf
	 */
	public void setRelevance(double tfidf);
	
	/**
	 * Gets the tf-idf value for the terminology
	 * @return TF-IDF value
	 */
	public double getRelevance();
	
}
